Socket
Socket
Sign inDemoInstall

gemini-configparser

Package Overview
Dependencies
Maintainers
9
Versions
16
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

gemini-configparser


Version published
Maintainers
9
Created

Readme

Source

@gemini/configparser

Parser for gemini configuration files.

Config is described with a combination of a functions:

var parser = root(section({
    system: section({
        parallelLimit: option({
            parseEnv: Number,
            parseCli: Number,
            validate: function() {...}
        })
    }),
    browsers: map(
        section({
            calibrate: option(...),
            windowSize: option(...)
        })
    )
})

There are 4 types of values:

  • option({defaultValue, parseCli, parseEnv, validate, map}) - a single scalar option.
    • defaultValue - a default value to use if option is not provided
    • defaultValue(config, currentNode) - a function to compute default value
    • parseCli(value) - a function used to parse command-line arguments
    • parseEnv(value) - a function used to parse environment variable
    • validate(value, config, currentNode, meta) - a function used to validate the option value
    • map(value, config, currentNode, meta) - a function used to transform the option value
  • section({sectionName1: valueParser1, sectionName2: valueParser2, ...}) - a section of a values with specified key names. Each option will parsed with appropriate parser function. Any unknown value passed by user will be treated as an error.
  • map(valueParser, defaultValue) - a map with any number of user-specified keys. Each value is parsed by valueParser. If set, defaultValue will be used in case of no user-specified data provided.
  • root(parser, {envPrefix, cliPrefix}) - creates a root config parsers from specifed parser function. Returns function with signature f({options, env, argv}).

FAQs

Last updated on 03 Apr 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc